
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>params.Scales.get_variables &#8212; Texas A&amp;M Oil spill / Outfall Calculator 2.1.0 documentation</title>
    <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="params.Scales.h_P" href="params.Scales.h_P.html" />
    <link rel="prev" title="params.Scales" href="params.Scales.html" />
   
  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="params-scales-get-variables">
<h1>params.Scales.get_variables<a class="headerlink" href="#params-scales-get-variables" title="Permalink to this headline">¶</a></h1>
<dl class="method">
<dt id="params.Scales.get_variables">
<code class="sig-prename descclassname">Scales.</code><code class="sig-name descname">get_variables</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">z0</em>, <em class="sig-param">u_inf</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/params.html#Scales.get_variables"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#params.Scales.get_variables" title="Permalink to this definition">¶</a></dt>
<dd><p>Compute the governing variables at a given depth</p>
<p>Compute the governing variables B (kinematic buoyancy flux), N 
(buoyancy frequency) and u_slip (dispersed-phase slip velocity) at 
the given depth and cross-flow velocity.  These are the main 
ingredients to each of the scales calculations.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>z0</strong><span class="classifier">float</span></dt><dd><p>Depth to evaluate the governing variables (m)</p>
</dd>
<dt><strong>u_inf</strong><span class="classifier">float</span></dt><dd><p>Magnitude of the local ambient cross-flow velocity (m/s)</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt>A tuble containing the governing variables:</dt><dd><dl class="simple">
<dt>B<span class="classifier">float</span></dt><dd><p>Total kinematic buoyancy flux of all dispersed phases 
together (m^4/s^3)</p>
</dd>
<dt>N<span class="classifier">float</span></dt><dd><p>Local value of the ambient buoyancy frequency (1/s)</p>
</dd>
<dt>u_slip<span class="classifier">float</span></dt><dd><p>Slip velocity of the dispersed phase containing the greatest
buoyancy flux (m/s)</p>
</dd>
<dt>u_inf<span class="classifier">float</span></dt><dd><p>Magnitude of the local ambient cross-flow velocity (m/s)
TODO (S. Socolofsky, October 2013): Eventually, this should
be read from the ambient CTD data and removed as an input to
this method.</p>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>When more than one dispersed phase particle is present, the slip 
velocity used as the governing variables is the value for the 
dispersed phase particle that has the greatest effect on the dynamics
of the plume.  This particle is the one for which the buoyancy flux
is highest.  The governing variables, B, on the other hand is the 
total buoyancy flux of all dispersed phase particles combined.  This 
is consistent with the way the governing parameters have been used 
in papers by Socolofsky and Adams (e.g., Socolofsky et al. 2011).</p>
</dd></dl>

</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">Texas A&M Oil spill / Outfall Calculator</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../user_manual.html">TAMOC User Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../unit_tests.html">Unit Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../readme.html">Read Me File</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../release.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../../index.html">Documentation overview</a><ul>
  <li><a href="../../user_manual.html">TAMOC User Manual</a><ul>
  <li><a href="../../modules/params.html">Overview of Parameters Module</a><ul>
  <li><a href="params.Scales.html">params.Scales</a><ul>
      <li>Previous: <a href="params.Scales.html" title="previous chapter">params.Scales</a></li>
      <li>Next: <a href="params.Scales.h_P.html" title="next chapter">params.Scales.h_P</a></li>
  </ul></li>
  </ul></li>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, Scott A. Socolofsky.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="../../_sources/autodoc/params/params.Scales.get_variables.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>